Node / meshtastic / Meshtastic-Android / files / feature / firmware / src / commonMain / kotlin / org / meshtastic / feature / firmware / FirmwareUpdateState.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.feature.firmware

Tff7b72import T7ee787org.meshtastic.core.database.entity.FirmwareRelease

Tff7b72import T7ee787org.meshtastic.core.model.DeviceHardware

Tff7b72import T7ee787org.meshtastic.core.resources.UiText

T8b949e/**

* Represents the progress of a long-running firmware update task.

*

* @property message A high-level status message (e.g., "Downloading...").

* @property progress A value between 0.0 and 1.0 representing completion percentage.

* @property details Optional high-frequency detail text (e.g., "1.2 MiB/s, 45%").

* @property hint Optional persistent advisory shown alongside the progress (e.g. a slow-bootloader tip).

*/

Tff7b72data Tff7b72class T56d364ProgressStateTb4b4b4(

Tff7b72val Te6edf3messageTb4b4b4: Te6edf3UiText Tff7b72= Te6edf3UiTextTb4b4b4.Te6edf3DynamicStringTb4b4b4(Ta5d6ff"Ta5d6ff"Tb4b4b4)Tb4b4b4,

Tff7b72val Te6edf3progressTb4b4b4: Tffa657Float Tff7b72= T79c0ff0fTb4b4b4,

Tff7b72val Te6edf3detailsTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

Tff7b72val Te6edf3hintTb4b4b4: Te6edf3UiText? Tff7b72= Tff7b72nullTb4b4b4,

Tb4b4b4)

T8b949e/** State machine for the firmware update flow, observed by [FirmwareUpdateScreen]. */

Tff7b72sealed Tff7b72interface T56d364FirmwareUpdateState Tb4b4b4{

T8b949e/** No update activity — initial state before [FirmwareUpdateViewModel.checkForUpdates] runs. */

Tff7b72data Tff7b72object T56d364Idle Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Resolving device hardware and fetching available firmware releases. */

Tff7b72data Tff7b72object T56d364Checking Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Device and release info resolved; the user may initiate an update. */

Tff7b72data Tff7b72class T56d364ReadyTb4b4b4(

Tff7b72val Te6edf3releaseTb4b4b4: Te6edf3FirmwareRelease?Tb4b4b4,

Tff7b72val Te6edf3deviceHardwareTb4b4b4: Te6edf3DeviceHardwareTb4b4b4,

T8b949e/** Bare device address with the `InterfaceId` transport prefix stripped (e.g. MAC or IP). */

Tff7b72val Te6edf3addressTb4b4b4: Tffa657StringTb4b4b4,

Tff7b72val Te6edf3showBootloaderWarningTb4b4b4: Tffa657BooleanTb4b4b4,

Tff7b72val Te6edf3updateMethodTb4b4b4: Te6edf3FirmwareUpdateMethodTb4b4b4,

Tff7b72val Te6edf3currentFirmwareVersionTb4b4b4: Tffa657String? Tff7b72= Tff7b72nullTb4b4b4,

T8b949e/**

* True when reached while disconnected to re-flash a device stranded in bootloader mode after an interrupted

* update (see [FirmwareUpdateViewModel.checkForUpdates]). Drives recovery-specific copy and routing.

*/

Tff7b72val Te6edf3isRecoveryTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4,

Tb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Firmware file is being downloaded from the release server. */

Tff7b72data Tff7b72class T56d364DownloadingTb4b4b4(Tff7b72val Te6edf3progressStateTb4b4b4: Te6edf3ProgressStateTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Intermediate processing (e.g. extracting, preparing DFU). */

Tff7b72data Tff7b72class T56d364ProcessingTb4b4b4(Tff7b72val Te6edf3progressStateTb4b4b4: Te6edf3ProgressStateTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Firmware is actively being written to the device. */

Tff7b72data Tff7b72class T56d364UpdatingTb4b4b4(Tff7b72val Te6edf3progressStateTb4b4b4: Te6edf3ProgressStateTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** Waiting for the device to reboot and reconnect after a successful flash. */

Tff7b72data Tff7b72object T56d364Verifying Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** The device did not reconnect within the expected timeout after flashing. */

Tff7b72data Tff7b72object T56d364VerificationFailed Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** An error occurred at any stage of the update pipeline. */

Tff7b72data Tff7b72class T56d364ErrorTb4b4b4(Tff7b72val Te6edf3errorTb4b4b4: Te6edf3UiTextTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/**

* The firmware update completed and the device reconnected successfully.

*

* @property wasLowSpeedTransfer True if the upload ran at the MTU-capped low speed (stock bootloader), so the

* Success screen can offer a one-time OTAFIX upgrade tip for faster future updates.

*/

Tff7b72data Tff7b72class T56d364SuccessTb4b4b4(Tff7b72val Te6edf3wasLowSpeedTransferTb4b4b4: Tffa657Boolean Tff7b72= Tff7b72falseTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

T8b949e/** UF2 file is ready; waiting for the user to choose a save location (USB flow). */

Tff7b72data Tff7b72class T56d364AwaitingFileSaveTb4b4b4(Tff7b72val Te6edf3uf2ArtifactTb4b4b4: Te6edf3FirmwareArtifactTb4b4b4, Tff7b72val Te6edf3fileNameTb4b4b4: Tffa657StringTb4b4b4) Tb4b4b4: Te6edf3FirmwareUpdateState

Tb4b4b4}

Tff7b72private Tff7b72val Te6edf3FORMAT_ARG_REGEX Tff7b72= Te6edf3RegexTb4b4b4(Ta5d6ff"Ta5d6ff:?Ta5d6ff\\Ta5d6ffs*%1Ta5d6ff\\Ta5d6ff\Tffd700$Te6edf3dTa5d6ff%?Ta5d6ff"Tb4b4b4)

T8b949e/** Strip positional format arguments (e.g. `%1$d`) from a localized template to get a clean base message. */

Tff7b72internal Tff7b72fun Te6edf3StringTb4b4b4.Td2a8ffstripFormatArgsTb4b4b4(Tb4b4b4)Tb4b4b4: Tffa657String Tff7b72= Te6edf3replaceTb4b4b4(Te6edf3FORMAT_ARG_REGEXTb4b4b4, Ta5d6ff"Ta5d6ff"Tb4b4b4)Tb4b4b4.Te6edf3trimTb4b4b4(Tb4b4b4)